pubnub-kotlin-api/[root]/PubNub

PubNub

open external class PubNub(config: Any)

Constructors

PubNub

constructor(config: Any)

Types

Action

interface Action

ActionContentToAction

interface ActionContentToAction : JsMap<Array<PubNub.Action>>

ActionParam

interface ActionParam

ActionTypeToActions

interface ActionTypeToActions : JsMap<PubNub.ActionContentToAction>

AddChannelParameters

interface AddChannelParameters

AddMessageActionParameters

interface AddMessageActionParameters

APNS2Configuration

interface APNS2Configuration

APNS2Target

interface APNS2Target

APNSNotificationPayload

interface APNSNotificationPayload : PubNub.BaseNotificationPayload

BaseNotificationPayload

interface BaseNotificationPayload

BaseObjectsEvent

interface BaseObjectsEvent

BufferFileInput

interface BufferFileInput

ChannelGroups

interface ChannelGroups

ChannelMembershipObject

interface ChannelMembershipObject : PubNub.v2ObjectDataOmitId

ChannelMembersParameters

interface ChannelMembersParameters

ChannelMetadata

interface ChannelMetadata : PubNub.ObjectParam, PubNub.ChannelMetadataFieldsNullable

ChannelMetadataFieldsNullable

interface ChannelMetadataFieldsNullable

ChannelMetadataObject

interface ChannelMetadataObject : PubNub.v2ObjectData, PubNub.ChannelMetadataFieldsNullable

ChannelsToFetchMessageItemsMap

interface ChannelsToFetchMessageItemsMap : JsMap<Array<PubNub.FetchMessageItem>>

ChannelsToHereNowChannelData

interface ChannelsToHereNowChannelData : JsMap<PubNub.HereNowChannelData>

Companion

object Companion

CryptoModule

open class CryptoModule(configuration: PubNub.CryptoModuleConfiguration)

CryptoModuleConfiguration

interface CryptoModuleConfiguration

CryptoParameters

interface CryptoParameters

CryptorConfiguration

interface CryptorConfiguration

CustomObject

interface CustomObject : JsMap<Any>

DeleteFileResponse

interface DeleteFileResponse

DeleteGroupParameters

interface DeleteGroupParameters

DeleteMembershipObject

interface DeleteMembershipObject

DeleteMessagesParameters

interface DeleteMessagesParameters

DownloadFileParameters

interface DownloadFileParameters

EncryptedDataType

interface EncryptedDataType

FCMNotificationPayload

interface FCMNotificationPayload : PubNub.BaseNotificationPayload

FetchMessageItem

interface FetchMessageItem

FetchMessagesParameters

interface FetchMessagesParameters

FetchMessagesResponse

interface FetchMessagesResponse

FetchTimeResponse

interface FetchTimeResponse

FileEvent

interface FileEvent

FileInputParameters

interface FileInputParameters

FireParameters

interface FireParameters

GetAllMetadataParameters

interface GetAllMetadataParameters

GetChannelMembersParameters

interface GetChannelMembersParameters : PubNub.UUIDMembersParameters

GetChannelMetadataParameters

interface GetChannelMetadataParameters

GetMembershipsParametersv2

interface GetMembershipsParametersv2 : PubNub.ChannelMembersParameters

GetMessageActionsParameters

interface GetMessageActionsParameters

GetMessageActionsResponse

interface GetMessageActionsResponse

GetStateParameters

interface GetStateParameters

GetStateResponse

interface GetStateResponse

GetUUIDMetadataParameters

interface GetUUIDMetadataParameters

GrantParameters

interface GrantParameters

GrantTokenParameters

interface GrantTokenParameters

GrantTokenPermissions

interface GrantTokenPermissions

HasId

interface HasId

HasStatus

interface HasStatus

HereNowChannelData

interface HereNowChannelData

HereNowOccupantData

interface HereNowOccupantData

HereNowParameters

interface HereNowParameters

HereNowResponse

interface HereNowResponse

HistoryMessage

interface HistoryMessage

HistoryParameters

interface HistoryParameters

HistoryResponse

interface HistoryResponse

IncludeCustomFields

interface IncludeCustomFields

IncludeOptions

interface IncludeOptions

JsLogLevel

interface JsLogLevel

External interface representing PubNub.LogLevel enum from JavaScript SDK. Used as: PubNub.LogLevel.Debug, PubNub.LogLevel.Info, etc.

KeepAliveSettings

interface KeepAliveSettings

LegacyCryptor

interface LegacyCryptor<T>

ListAllGroupsResponse

interface ListAllGroupsResponse

ListChannelsParameters

interface ListChannelsParameters

ListChannelsResponse

interface ListChannelsResponse

ListenerParameters

interface ListenerParameters

ListFilesParameters

interface ListFilesParameters

ListFilesResponse

interface ListFilesResponse

MembershipIncludeOptions

interface MembershipIncludeOptions

MessageAction

interface MessageAction

MessageActionEvent

interface MessageActionEvent

MessageCountsParameters

interface MessageCountsParameters

MessageCountsResponse

interface MessageCountsResponse

MessageEvent

interface MessageEvent

MetadataIncludeOptions

interface MetadataIncludeOptions

MetadataPage

interface MetadataPage

NotificationsPayload

interface NotificationsPayload

ObjectParam

interface ObjectParam

Page

interface Page

ParsedGrantToken

interface ParsedGrantToken : PubNub.GrantTokenParameters

PatternsOrResources

interface PatternsOrResources

PNConfiguration

interface PNConfiguration : Partial

PresenceEvent

interface PresenceEvent

PublishFileParameters

interface PublishFileParameters

PublishFileResponse

interface PublishFileResponse

PublishParameters

interface PublishParameters

PublishResponse

interface PublishResponse

PubNubFileType

interface PubNubFileType

PubnubStatus

interface PubnubStatus

Push

interface Push

PushChannelParameters

interface PushChannelParameters

PushDeviceParameters

interface PushDeviceParameters

PushListChannelsResponse

interface PushListChannelsResponse

ReconnectParameters

interface ReconnectParameters

RemoveChannelMembersParameters

interface RemoveChannelMembersParameters : PubNub.UUIDMembersParameters

RemoveChannelMetadataEvent

interface RemoveChannelMetadataEvent : PubNub.BaseObjectsEvent

RemoveChannelMetadataParameters

interface RemoveChannelMetadataParameters

RemoveChannelParameters

interface RemoveChannelParameters

RemoveMembershipEvent

interface RemoveMembershipEvent : PubNub.BaseObjectsEvent

RemoveMembershipsParameters

interface RemoveMembershipsParameters : PubNub.ChannelMembersParameters

RemoveMessageActionParameters

interface RemoveMessageActionParameters

RemoveUUIDMetadataEvent

interface RemoveUUIDMetadataEvent : PubNub.BaseObjectsEvent

RemoveUUIDMetadataParameters

interface RemoveUUIDMetadataParameters

RevokeTokenResponse

interface RevokeTokenResponse

SendFileParameters

interface SendFileParameters

SendFileResponse

interface SendFileResponse

SetChannelMembersParameters

interface SetChannelMembersParameters : PubNub.UUIDMembersParameters

SetChannelMetadataEvent

interface SetChannelMetadataEvent : PubNub.BaseObjectsEvent

SetChannelMetadataParameters

interface SetChannelMetadataParameters

SetCustom

interface SetCustom

SetMembershipEvent

interface SetMembershipEvent : PubNub.BaseObjectsEvent

SetMembershipObject

interface SetMembershipObject

SetMembershipsParameters

interface SetMembershipsParameters : PubNub.ChannelMembersParameters

SetStateParameters

interface SetStateParameters

SetStateResponse

interface SetStateResponse

SetUUIDMetadataEvent

interface SetUUIDMetadataEvent : PubNub.BaseObjectsEvent

SetUUIDMetadataParameters

interface SetUUIDMetadataParameters

SignalEvent

interface SignalEvent

SignalParameters

interface SignalParameters

SignalResponse

interface SignalResponse

StatusEvent

interface StatusEvent

StatusListenerParameters

interface StatusListenerParameters

StreamFileInput

interface StreamFileInput

SubscribeParameters

interface SubscribeParameters

SubscriptionOptions

interface SubscriptionOptions

SubscriptionSetParams

interface SubscriptionSetParams

interface T$10

interface T$11

interface T$13

interface T$15

interface T$37

interface T$5

interface T$6

interface T$7

interface T$9

UnsubscribeParameters

interface UnsubscribeParameters

UploadedFile

interface UploadedFile

UriFileInput

interface UriFileInput

UuidIncludeCustom

interface UuidIncludeCustom

UUIDMembershipObject

interface UUIDMembershipObject : PubNub.v2ObjectDataOmitId

UUIDMembersParameters

interface UUIDMembersParameters

UUIDMetadata

interface UUIDMetadata : PubNub.ObjectParam, PubNub.UUIDMetadataFieldsNullable, Partial

UUIDMetadataFieldsNullable

interface UUIDMetadataFieldsNullable

UUIDMetadataObject

interface UUIDMetadataObject : PubNub.v2ObjectData, PubNub.UUIDMetadataFieldsNullable

v2ObjectData

interface v2ObjectData

v2ObjectDataOmitId

interface v2ObjectDataOmitId

WhereNowParameters

interface WhereNowParameters

WhereNowResponse

interface WhereNowResponse

Properties

channelGroups

open var channelGroups: PubNub.ChannelGroups

objects

open var objects: ObjectsFunctions

push

open var push: PubNub.Push

Functions

addListener

open fun addListener(params: PubNub.ListenerParameters)

open fun addListener(params: PubNub.StatusListenerParameters)

addMessageAction

open fun addMessageAction(params: PubNub.AddMessageActionParameters): Promise<AddMessageActionResult>

open fun addMessageAction(params: PubNub.AddMessageActionParameters, callback: Callback<AddMessageActionResult>)

decrypt

open fun decrypt(data: Any?): Any

open fun decrypt(data: String?): Any

open fun decrypt(data: Any?, customCipherKey: String = definedExternally): Any

open fun decrypt(data: String?, customCipherKey: String = definedExternally): Any

open fun decrypt(data: Any?, customCipherKey: String = definedExternally, options: PubNub.CryptoParameters = definedExternally): Any

open fun decrypt(data: String?, customCipherKey: String = definedExternally, options: PubNub.CryptoParameters = definedExternally): Any

deleteFile

open fun deleteFile(params: PubNub.FileInputParameters): Promise<PubNub.DeleteFileResponse>

open fun deleteFile(params: PubNub.FileInputParameters, callback: StatusCallback)

deleteMessages

open fun deleteMessages(params: PubNub.DeleteMessagesParameters): Promise<Unit>

open fun deleteMessages(params: PubNub.DeleteMessagesParameters, callback: StatusCallback)

destroy

open fun destroy()

disconnect

open fun disconnect()

downloadFile

open fun downloadFile(params: PubNub.DownloadFileParameters): Promise<Any>

open fun downloadFile(params: PubNub.DownloadFileParameters, callback: Callback<Any>)

encrypt

open fun encrypt(data: String, customCipherKey: String = definedExternally, options: PubNub.CryptoParameters = definedExternally): String

fetchMessages

open fun fetchMessages(params: PubNub.FetchMessagesParameters): Promise<PubNub.FetchMessagesResponse>

open fun fetchMessages(params: PubNub.FetchMessagesParameters, callback: Callback<PubNub.FetchMessagesResponse>)

fire

open fun fire(params: PubNub.FireParameters): Promise<PubNub.PublishResponse>

open fun fire(params: PubNub.FireParameters, callback: Callback<PubNub.PublishResponse>)

getFileUrl

open fun getFileUrl(params: PubNub.FileInputParameters): String

getFilterExpression

open fun getFilterExpression(): String

getMessageActions

open fun getMessageActions(params: PubNub.GetMessageActionsParameters): Promise<PubNub.GetMessageActionsResponse>

open fun getMessageActions(params: PubNub.GetMessageActionsParameters, callback: Callback<PubNub.GetMessageActionsResponse>)

getState

open fun getState(params: PubNub.GetStateParameters): Promise<PubNub.GetStateResponse>

open fun getState(params: PubNub.GetStateParameters, callback: Callback<PubNub.GetStateResponse>)

getSubscribedChannelGroups

open fun getSubscribedChannelGroups(): Array<String>

getSubscribedChannels

open fun getSubscribedChannels(): Array<String>

getToken

open fun getToken(): String?

getUUID

open fun getUUID(): String

grant

open fun grant(params: PubNub.GrantParameters): Promise<Unit>

open fun grant(params: PubNub.GrantParameters, callback: StatusCallback)

grantToken

open fun grantToken(params: PubNub.GrantTokenParameters): Promise<String>

open fun grantToken(params: PubNub.GrantTokenParameters, callback: Callback<String>)

hereNow

open fun hereNow(params: PubNub.HereNowParameters): Promise<PubNub.HereNowResponse>

open fun hereNow(params: PubNub.HereNowParameters, callback: Callback<PubNub.HereNowResponse>)

history

open fun history(params: PubNub.HistoryParameters): Promise<PubNub.HistoryResponse>

open fun history(params: PubNub.HistoryParameters, callback: Callback<PubNub.HistoryResponse>)

listFiles

open fun listFiles(params: PubNub.ListFilesParameters): Promise<PubNub.ListFilesResponse>

open fun listFiles(params: PubNub.ListFilesParameters, callback: Callback<PubNub.ListFilesResponse>)

messageCounts

open fun messageCounts(params: PubNub.MessageCountsParameters): Promise<PubNub.MessageCountsResponse>

open fun messageCounts(params: PubNub.MessageCountsParameters, callback: Callback<PubNub.MessageCountsResponse>)

parseToken

open fun parseToken(params: String): PubNub.ParsedGrantToken

publish

open fun publish(params: PubNub.PublishParameters): Promise<PubNub.PublishResponse>

open fun publish(params: PubNub.PublishParameters, callback: Callback<PubNub.PublishResponse>)

publishFile

open fun publishFile(params: PubNub.PublishFileParameters): Promise<PubNub.PublishFileResponse>

open fun publishFile(params: PubNub.PublishFileParameters, callback: Callback<PubNub.PublishFileResponse>)

reconnect

open fun reconnect(params: PubNub.ReconnectParameters)

removeListener

open fun removeListener(params: Any)

removeMessageAction

open fun removeMessageAction(params: PubNub.RemoveMessageActionParameters): Promise<RemoveMessageActionResult>

open fun removeMessageAction(params: PubNub.RemoveMessageActionParameters, callback: Callback<RemoveMessageActionResult>)

revokeToken

open fun revokeToken(params: String): Promise<PubNub.RevokeTokenResponse>

open fun revokeToken(params: String, callback: Callback<PubNub.RevokeTokenResponse>)

sendFile

open fun sendFile(params: PubNub.SendFileParameters): Promise<PubNub.SendFileResponse>

open fun sendFile(params: PubNub.SendFileParameters, callback: Callback<PubNub.SendFileResponse>)

setAuthKey

open fun setAuthKey(authKey: String)

setFilterExpression

open fun setFilterExpression(filterExpression: String)

setState

open fun setState(params: PubNub.SetStateParameters): Promise<PubNub.SetStateResponse>

open fun setState(params: PubNub.SetStateParameters, callback: Callback<PubNub.SetStateResponse>)

setToken

open fun setToken(params: String?)

setUUID

open fun setUUID(uuid: String)

signal

open fun signal(params: PubNub.SignalParameters): Promise<PubNub.SignalResponse>

open fun signal(params: PubNub.SignalParameters, callback: Callback<PubNub.SignalResponse>)

stop

open fun stop()

open fun subscribe(params: PubNub.SubscribeParameters)

time

open fun time(): Promise<PubNub.FetchTimeResponse>

open fun time(callback: Callback<PubNub.FetchTimeResponse>)

unsubscribe

open fun unsubscribe(params: PubNub.UnsubscribeParameters)

unsubscribeAll

open fun unsubscribeAll()

whereNow

open fun whereNow(params: PubNub.WhereNowParameters): Promise<PubNub.WhereNowResponse>

open fun whereNow(params: PubNub.WhereNowParameters, callback: Callback<PubNub.WhereNowResponse>)